Skip to content

Book: Update link title to match cookbook article title #4530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from

Conversation

dangarzon
Copy link
Contributor

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets

Article title updated in c9fe05b

@@ -898,7 +898,7 @@ The extension alias (configuration key) can also be used:
.. note::

See the cookbook article:
:doc:`How to expose a Semantic Configuration for a Bundle </cookbook/bundles/extension>`
:doc:`How to Load Service Configuration inside a Bundle </cookbook/bundles/extension>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'probably better if we just don't use a title here. Then, the referenced article's title will automatically be taken:

:doc:`/cookbook/bundles/extension`

@xabbuh
Copy link
Member

xabbuh commented Nov 29, 2014

Thank you for noticing and for providing a patch @dangarzon. As you have seen, simply using the documents title is a bit error prone when the referenced document's title changes. Therefore, I would suggest to simply omit the title here and let Sphinx do all the work for us.

@dangarzon
Copy link
Contributor Author

@xabbuh
Done, link modified without title

@xabbuh
Copy link
Member

xabbuh commented Nov 29, 2014

@dangarzon Thank you. Can you even reorder the paragraph so that uses almost all available space of a line (simply wrap lines after the first word that crosses the 72nd character).

@dangarzon
Copy link
Contributor Author

@xabbuh like this?

@xabbuh
Copy link
Member

xabbuh commented Nov 29, 2014

@dangarzon Exactly 👍

@dangarzon
Copy link
Contributor Author

Nice!

@wouterj
Copy link
Member

wouterj commented Nov 29, 2014

Thanks Daniel! Good catch

wouterj added a commit that referenced this pull request Nov 29, 2014
…dangarzon)

This PR was squashed before being merged into the 2.3 branch (closes #4530).

Discussion
----------

Book: Update link title to match cookbook article title

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Article title updated in c9fe05b

Commits
-------

37c29e9 Book: Update link title to match cookbook article title
@wouterj wouterj closed this Nov 29, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants